Get the task-based match score between two Job Families

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "job_family_id": "b0035050-eb84-42dc-a79f-5e7b1fe897b7",
  "target_job_family_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "score": 0.42
}

Get the task-based match score between two Job Families

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/job_families/{other_job_family_external_id}/task_match")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "job_family_id": "b0035050-eb84-42dc-a79f-5e7b1fe897b7",
  "target_job_family_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "score": 0.42
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

read

allows reading resources

Path Parameters

job_family_external_id

string<uuid>

required

Unique external ID linked to this Job, consisting of alphanumeric characters, hyphens and underscores. The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

other_job_family_external_id

string<uuid>

required

Unique external ID linked to the target Job Family to compare against, consisting of alphanumeric characters, hyphens and underscores. The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Query Parameters

response_format

enum<string>

default:simple

If set to explained, the response will include an explanation of the match.

Available options:

simple,

explained

Example:

"explained"

Response

Option 1
Explained

A task-based match result between two Job Families.

job_family_id

string<uuid>

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"b0035050-eb84-42dc-a79f-5e7b1fe897b7"

target_job_family_id

string<uuid>

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

score

number<float>

required

The symmetric task-based match score between the two Job Families, expressed as a number between 0 and 1.

Required range: 0 <= x <= 1

Example:

0.42

API Documentation

API Versioning

AI Integration

Taxonomy

Employees

Job Families

Jobs

Peer Groups

Vacancies

Courses

Skill Clusters

External Companies

Skills

Tasks

Organisational Structure

Custom Properties

Matchmaking

Matching Configuration

Export

Reports

Version

Get the task-based match score between two Job Families

Authorizations

Scopes

Path Parameters

Query Parameters

Response